M

ParameterFilterElement.ElementFilterIsAcceptableForParameterFilterElement(Document, ISet<ElementId>, ElementFilter)

Description:
Checks that an ElementFilter is acceptable for use in defining the filtering rules for a given list of categories (i.e., for view filtering).

Remarks:
ElementFilter is either an ElementParameterFilter or an ElementLogicalFilter representing a Boolean combination of ElementParameterFilters. In addition, we check that each ElementParameterFilter satisfies the following conditions: Its array of FilterRules is not empty and contains:

Any number of FilterRules of type FilterValueRule, FilterInverseRule, and SharedParameterApplicableRule or
Exactly one FilterCategoryRule containing only one category from categories stored by this ParameterFilterElement or
Exactly two rules: the first one is a FilterCategoryRule containing only one category from categories stored by this ParameterFilterElement and the second one is a FilterRule of type FilterValueRule, FilterInverseRule, or SharedParameterApplicableRule.

Note that cases in the second and third bullet are currently allowed only if the parent node of ElementParameterFilter is LogicalOrFilter.

Overloads (2):

ElementFilterIsAcceptableForParameterFilterElement(Document,ISet[ElementId],ElementFilter)

ElementFilterIsAcceptableForParameterFilterElement(ElementFilter)

public static bool ElementFilterIsAcceptableForParameterFilterElement(
	Document aDocument,
	ISet<ElementId> categories,
	ElementFilter elementFilter
)

Public Shared Function ElementFilterIsAcceptableForParameterFilterElement ( _
	aDocument As Document, _
	categories As ISet(Of ElementId), _
	elementFilter As ElementFilter _
) As Boolean

public:
static bool ElementFilterIsAcceptableForParameterFilterElement(
	Document^ aDocument, 
	ISet<ElementId^>^ categories, 
	ElementFilter^ elementFilter
)

Autodesk.Revit.DB.Document

aDocument

The document in which to create the ParameterFilterElement.
ISet<ElementId>

categories

The categories for the new ParameterFilterElement.
Autodesk.Revit.DB.ElementFilter

elementFilter

The ElementFilter to validate.

Return Value bool

Autodesk.Revit.Exceptions.ArgumentNullException

A non-optional argument was null

Share a snippet Help the community

Loading…

ParameterFilterElement.ElementFilterIsAcceptableForParameterFilterElement(Document, ISet<ElementId>, ElementFilter)

Syntax

Parameters

Exceptions

Community Snippets

Discussion … comments